APROPOS
Section: Misc. Reference Manual Pages (1
)
Index
Return to Main Contents
NAME
apropos - find pertinent online documentation
SYNOPSIS
apropos
[
-P
path
] [
-s
section
]
word...
DESCRIPTION
The
apropos
command displays a one line synopsis of each online documentation
file whose name or description contains a specified
word
or whose keywords listed in the
whatis
databases matches the specified
word.
Once you know what you are looking for, use
man(1)
to read the appropriate documentation.
The argument
word
is considered separately from each other word.
The case of letters is ignored.
OPTIONS
The following switch options are recognized:
- -P path
-
if a valid
path
is given,
apropos
searches for the databases there (see ENVIRONMENT).
- -s section
-
search only for items from the specified
section.
This should be a single character representing a section of the
manual, i.e., from the list:
0123456789lno
EXAMPLE
Try ``apropos editor'' and ``apropos disk'' to get a feel
for what
apropos
does.
ENVIRONMENT
Apropos
searches for the database file in the directory contained
in the
MANPATH
environment variable.
Note that the
-P
option overrides this.
If neither
MANPATH
or
-P
are specified, a default path of ``d:/usr/man'' is used.
NOTES
Apropos
performs a simple string search.
For example, ``apropos man'' finds all instances of command,
manipulate, mantissa, permanent, and so forth.
FILES
MANPATH/whatis._?_ online documentation database file
SEE ALSO
man(1), whatis(1), whatisin(1), whereis(1)
AUTHOR
Bill Rosenkranz
rosenkra@convex.com
VERSION
apropos 2.0.1 92/9/12 rosenkra
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- EXAMPLE
-
- ENVIRONMENT
-
- NOTES
-
- FILES
-
- SEE ALSO
-
- AUTHOR
-
- VERSION
-
This document was created by
man2html,
using the manual pages.
Time: 03:58:29 GMT, September 10, 2022